home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / dmedia / dmicsend.z / dmicsend
Encoding:
Text File  |  2002-10-03  |  5.4 KB  |  133 lines

  1.  
  2.  
  3.  
  4. ddddmmmmIIIICCCC((((3333ddddmmmm))))                                                            ddddmmmmIIIICCCC((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ddddmmmmIIIICCCCSSSSeeeennnndddd,,,, - transfer input to the image converter context
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmm____iiiimmmmaaaaggggeeeeccccoooonnnnvvvveeeerrrrtttt....hhhh>>>>
  13.  
  14.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmIIIICCCCSSSSeeeennnndddd((((DDDDMMMMiiiimmmmaaaaggggeeeeccccoooonnnnvvvveeeerrrrtttteeeerrrr ccccoooonnnnvvvveeeerrrrtttteeeerrrr,,,, DDDDMMMMbbbbuuuuffffffffeeeerrrr ssssrrrrccccBBBBuuuuffffffffeeeerrrr,,,,
  15.      iiiinnnntttt nnnnuuuummmmRRRReeeeffffBBBBuuuuffffffffeeeerrrrssss,,,, DDDDMMMMbbbbuuuuffffffffeeeerrrr ****rrrreeeeffffBBBBuuuuffffffffeeeerrrrssss))));;;;
  16.  
  17. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  18.      This function sends a source buffer together with its reference buffers
  19.      to the image converter.
  20.  
  21.      _c_o_n_v_e_r_t_e_r    the converter instance
  22.  
  23.      _s_r_c_B_u_f_f_e_r    the source buffer
  24.  
  25.      _n_u_m_R_e_f_B_u_f_f_e_r_s
  26.                   the number of reference buffers pointed to by _r_e_f_B_u_f_f_e_r_s
  27.  
  28.      _r_e_f_B_u_f_f_e_r_s   an array of reference buffers
  29.  
  30. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  31.      The converter will perform the conversion on the srcBuffer, based on the
  32.      conversion context.  Prior to calling ddddmmmmIIIICCCCSSSSeeeennnndddd, ddddmmmmIIIICCCCSSSSeeeettttSSSSrrrrccccPPPPaaaarrrraaaammmmssss and
  33.      ddddmmmmIIIICCCCSSSSeeeettttDDDDssssttttPPPPaaaarrrraaaammmmssss should be called to provide the necessary parameters
  34.      needed to set up the conversion context accordingly.
  35.  
  36.      The buffer, _s_r_c_B_u_f_f_e_r, must be allocated by the caller (see
  37.      ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeee((((3333ddddmmmm))))).  When the buffer is sent to the converter, the
  38.      converter will do the necessary attachment to the buffer.  The buffer can
  39.      be freed (see ddddmmmmBBBBuuuuffffffffeeeerrrrFFFFrrrreeeeeeee((((3333ddddmmmm))))) after ddddmmmmIIIICCCCSSSSeeeennnndddd returns, if it is no
  40.      longer referenced or needed.
  41.  
  42.      The contents of _s_r_c_B_u_f_f_e_r should not be modified after calling ddddmmmmIIIICCCCSSSSeeeennnndddd.
  43.  
  44.      ddddmmmmIIIICCCCSSSSeeeennnndddd is an asynchronous operation.  When ddddmmmmIIIICCCCSSSSeeeennnndddd returns, conversion
  45.      may or may not have been performed. ddddmmmmIIIICCCCGGGGeeeettttDDDDssssttttFFFFiiiilllllllleeeedddd can be used to
  46.      determine if any output is available.
  47.  
  48.      Two types of error can occur in ddddmmmmIIIICCCCSSSSeeeennnndddd.  Either the input queue is full
  49.      or any of the parameters passed to the function is invalid. In software
  50.      codecs the queues grow until you run out of memory. However in case of
  51.      hardware codecs it is not so.  In these cases, DDDDMMMM____FFFFAAAAIIIILLLLUUUURRRREEEE is returned and
  52.      an error is set (errors can be retrieved using dmGetError(3dm)).
  53.  
  54.      If an error occurs during the conversion after ddddmmmmIIIICCCCSSSSeeeennnndddd has returned, an
  55.      error will be returned in a subsequent ddddmmmmIIIICCCCRRRReeeecccceeeeiiiivvvveeee call.  For example, if
  56.      invalid bytes are passed to an image converter, ddddmmmmIIIICCCCRRRReeeecccceeeeiiiivvvveeee on the
  57.      corresponding expected output buffer will return DDDDMMMM____FFFFAAAAIIIILLLLUUUURRRREEEE (see
  58.      ddddmmmmIIIICCCCRRRReeeecccceeeeiiiivvvveeee((((3333ddddmmmm))))).
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ddddmmmmIIIICCCC((((3333ddddmmmm))))                                                            ddddmmmmIIIICCCC((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. NNNNOOOOTTTTEEEESSSS
  75.      In the current release, numRefBuffers and refBuffers are ignored.
  76.  
  77. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  78.      dmBufferAllocate(3dm), dmICSetSrcParams(3dm), dmICSetDstParams(3dm),
  79.      dmICSetConvParams(3dm), dmICReceive(3dm), dmICWork(3dm).
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.